From 94a8c58fbc44815518248167f0bb488eefb6a0f0 Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Sat, 4 Jun 2011 11:31:22 +0000 Subject: [PATCH] * (bug 29265) Mediawiki API documentation incomplete Flesh out documentation for the maxlag parameter --- includes/api/ApiMain.php | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index a15faeefa8..f3ab32b92e 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -752,7 +752,14 @@ class ApiMain extends ApiBase { 'format' => 'The format of the output', 'action' => 'What action you would like to perform. See below for module help', 'version' => 'When showing help, include version for each module', - 'maxlag' => 'Maximum lag', + 'maxlag' => array( + 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.', + 'To save actions causing any more site replication lag, this parameter can make the client', + 'wait until the replication lag is less than the specified value.', + 'In case of a replag error, a HTTP 503 error is returned, with the message like', + '"Waiting for $host: $lag seconds lagged\n".', + 'See http://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information', + ), 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached', 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached', 'requestid' => 'Request ID to distinguish requests. This will just be output back to you', -- 2.20.1